Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
IpsecProcess Class Reference

IpsecProcess is the process that handles IPSec. More...

Inheritance diagram for IpsecProcess:
Process

Public Member Functions

int getGlobalLifeTime ()
 Returns the global lifetime for encryption. More...
 
void setGlobalLifeTime (int)
 Sets the global lifetime for encryption. More...
 
int getCryptoMapSetCount ()
 Returns the number of crypto map sets. More...
 
CryptoMapSet getCryptoMapSetAt (int)
 Returns the crypto map set at the specified index. More...
 
void addCryptoMapSetByNameSeq (string, int)
 Adds a crypto map set with the specified name and sequence number. More...
 
int getTransformSetCount ()
 Returns the number of transform sets. More...
 
TransformSet getTransformSetAt (int)
 Returns the transform set at the specified index. More...
 
TransformSet getTransformSetbyName (string)
 Returns the transform set with the specified name. More...
 
void addTransformSetByName (string)
 Adds a transform set with the specified name. More...
 
void removeTransformSetByName (string)
 Removes the transform set with the specified name. More...
 
bool isTransformSetUsedByMap (string)
 Returns true if the specified transform set is used by the crypto map, otherwise false. More...
 
int getIkePolicyCount ()
 Returns the number of IKE policies. More...
 
IkePolicy getIkePolicyAt (int)
 Returns IKE policy at the specified index. More...
 
int getTunnelGrpCount ()
 Returns the number of Tunnel Group. More...
 
TunnelGroup getTunnelGrpByName (string)
 gets the tunnel group with the specified name. More...
 
void addTunnelGrpByName (string)
 Adds a Tunnel Group with the specified name. More...
 
void removeTunnelGrpByName (string)
 Removes the Tunnel Group with the specified name. More...
 
TunnelGroup getTunnelGrpAt (int)
 Returns Tunnel Group at the specified index. More...
 
int getCryptoMapSetV6Count ()
 Returns the number of crypto map sets. More...
 
CryptoMapSet getCryptoMapSetV6At (int)
 Returns the crypto map set at the specified index. More...
 
void addCryptoMapSetByNameSeqV6 (string, int)
 Adds a crypto map set with the specified name and sequence number. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

IpsecProcess is the process that handles IPSec.

Member Function Documentation

◆ addCryptoMapSetByNameSeq()

void IpsecProcess::addCryptoMapSetByNameSeq ( string  ,
int   
)

Adds a crypto map set with the specified name and sequence number.

Parameters
name,thename of the crypto map set.
sequence,thesequence number of the crypto map set.

◆ addCryptoMapSetByNameSeqV6()

void IpsecProcess::addCryptoMapSetByNameSeqV6 ( string  ,
int   
)

Adds a crypto map set with the specified name and sequence number.

Parameters
name,thename of the crypto map set.
sequence,thesequence number of the crypto map set.

◆ addTransformSetByName()

void IpsecProcess::addTransformSetByName ( string  )

Adds a transform set with the specified name.

Parameters
name,thename for the transform set.

◆ addTunnelGrpByName()

void IpsecProcess::addTunnelGrpByName ( string  )

Adds a Tunnel Group with the specified name.

Parameters
name,thename for the Tunnel Group .

◆ getCryptoMapSetAt()

CryptoMapSet IpsecProcess::getCryptoMapSetAt ( int  )

Returns the crypto map set at the specified index.

Parameters
index,theindex of the crypto map set of interest.
Returns
CryptoMapSet, the CryptoMapSet object at the specified index.

◆ getCryptoMapSetCount()

int IpsecProcess::getCryptoMapSetCount ( )

Returns the number of crypto map sets.

Returns
int, the number of crypto map sets.

◆ getCryptoMapSetV6At()

CryptoMapSet IpsecProcess::getCryptoMapSetV6At ( int  )

Returns the crypto map set at the specified index.

Parameters
index,theindex of the crypto map set of interest.
Returns
CryptoMapSet, the CryptoMapSet object at the specified index.

◆ getCryptoMapSetV6Count()

int IpsecProcess::getCryptoMapSetV6Count ( )

Returns the number of crypto map sets.

Returns
int, the number of crypto map sets.

◆ getGlobalLifeTime()

int IpsecProcess::getGlobalLifeTime ( )

Returns the global lifetime for encryption.

Returns
int, the global lifetime for encryption.

◆ getIkePolicyAt()

IkePolicy IpsecProcess::getIkePolicyAt ( int  )

Returns IKE policy at the specified index.

Parameters
index,theindex of the IKE policy of interest.
Returns
IkePolicy, the IkePolicy object at the specified index.

◆ getIkePolicyCount()

int IpsecProcess::getIkePolicyCount ( )

Returns the number of IKE policies.

Returns
int, the number of IKE policies.

◆ getTransformSetAt()

TransformSet IpsecProcess::getTransformSetAt ( int  )

Returns the transform set at the specified index.

Parameters
index,theindex of the transform set of interest.
Returns
TransformSet, the TransformSet object at the specified index.

◆ getTransformSetbyName()

TransformSet IpsecProcess::getTransformSetbyName ( string  )

Returns the transform set with the specified name.

Parameters
name,thename of the transform set of interest.
Returns
TransformSet, the TransformSet object with the specified name.

◆ getTransformSetCount()

int IpsecProcess::getTransformSetCount ( )

Returns the number of transform sets.

Returns
int, the number of transform sets.

◆ getTunnelGrpAt()

TunnelGroup IpsecProcess::getTunnelGrpAt ( int  )

Returns Tunnel Group at the specified index.

Parameters
index,theindex of the Tunnel Group of interest.
Returns
Tunnel Group, the Tunnel Group object at the specified index.

◆ getTunnelGrpByName()

TunnelGroup IpsecProcess::getTunnelGrpByName ( string  )

gets the tunnel group with the specified name.

Parameters
name,thename for the tunnelGroup.

◆ getTunnelGrpCount()

int IpsecProcess::getTunnelGrpCount ( )

Returns the number of Tunnel Group.

Returns
int, the number of Tunnel Group.

◆ isTransformSetUsedByMap()

bool IpsecProcess::isTransformSetUsedByMap ( string  )

Returns true if the specified transform set is used by the crypto map, otherwise false.

Parameters
name,thename of the transform set of interest.
Returns
bool, true if the specified transform set is used by the crypto map, otherwise false.

◆ removeTransformSetByName()

void IpsecProcess::removeTransformSetByName ( string  )

Removes the transform set with the specified name.

Parameters
name,thename for the transform set.

◆ removeTunnelGrpByName()

void IpsecProcess::removeTunnelGrpByName ( string  )

Removes the Tunnel Group with the specified name.

Parameters
name,thename for the Tunnel Group.

◆ setGlobalLifeTime()

void IpsecProcess::setGlobalLifeTime ( int  )

Sets the global lifetime for encryption.

Parameters
lifetime,theglobal lifetime for encryption.

The documentation for this class was generated from the following file: